<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>robotide.editor.EditorPlugin</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="robotide-module.html">Package&nbsp;robotide</a> ::
        <a href="robotide.editor-module.html">Package&nbsp;editor</a> ::
        Class&nbsp;EditorPlugin
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class EditorPlugin</h1><p class="nomargin-top"><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin">source&nbsp;code</a></span></p>
<pre class="base-tree">
             object --+    
                      |    
<a href="robotide.pluginapi.plugin.Plugin-class.html">pluginapi.plugin.Plugin</a> --+
                          |
                         <strong class="uidshort">EditorPlugin</strong>
</pre>

<hr />
<p>The default editor plugin.</p>
<p>This plugin implements editors for the various items of Robot Framework
test data.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">application</span>)</span><br />
      Initialize the plugin with the provided data.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#enable" class="summary-sig-name">enable</a>(<span class="summary-sig-arg">self</span>)</span><br />
      This method is called by RIDE when the plugin is enabled.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.enable">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#disable" class="summary-sig-name">disable</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Called by RIDE when the plugin is disabled.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.disable">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#highlight_cell" class="summary-sig-name">highlight_cell</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">obj</span>,
        <span class="summary-sig-arg">row</span>,
        <span class="summary-sig-arg">column</span>)</span><br />
      Highlight a specific row/column of a test case or user keyword</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.highlight_cell">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#highlight" class="summary-sig-name">highlight</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">text</span>)</span><br />
      Highlight a specific text of a given data's editor</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.highlight">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#register_context_menu_hook_to_grid" class="summary-sig-name">register_context_menu_hook_to_grid</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">hook</span>)</span><br />
      Used to register own items to grid's right click context menu</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.register_context_menu_hook_to_grid">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#unregister_context_menu_hook_to_grid" class="summary-sig-name">unregister_context_menu_hook_to_grid</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">hook</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.unregister_context_menu_hook_to_grid">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#OnTreeItemSelected" class="summary-sig-name">OnTreeItemSelected</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnTreeItemSelected">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#OnOpenEditor" class="summary-sig-name">OnOpenEditor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnOpenEditor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#OnTabChanged" class="summary-sig-name">OnTabChanged</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnTabChanged">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#OnTabChanging" class="summary-sig-name">OnTabChanging</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">message</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnTabChanging">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.editor.EditorPlugin-class.html#OnSaveToModel" class="summary-sig-name">OnSaveToModel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">message</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnSaveToModel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#__getattr__" class="summary-sig-name">__getattr__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Provides convenient attribute access to saved settings.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.__getattr__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#add_tab" class="summary-sig-name">add_tab</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tab</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">allow_closing</span>=<span class="summary-sig-default">True</span>)</span><br />
      Adds the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">tab</tt> with the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">title</tt> to the tabbed notebook and shows it.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.add_tab">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#all_testcases" class="summary-sig-name">all_testcases</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns all test cases from all suites in one, unsorted list
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.all_testcases">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#allow_tab_closing" class="summary-sig-name">allow_tab_closing</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tab</span>)</span><br />
      Allows closing a tab that has been created using allow_closing=False.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.allow_tab_closing">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#config_panel" class="summary-sig-name">config_panel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">parent</span>)</span><br />
      Called by RIDE to get the plugin configuration panel.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.config_panel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#content_assist_values" class="summary-sig-name">content_assist_values</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Returns content assist values for currently selected item.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.content_assist_values">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#delete_tab" class="summary-sig-name">delete_tab</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tab</span>)</span><br />
      Deletes the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">tab</tt> added using <a href="robotide.pluginapi.plugin.Plugin-class.html#add_tab" class="link">add_tab</a>.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.delete_tab">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#disallow_tab_closing" class="summary-sig-name">disallow_tab_closing</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tab</span>)</span><br />
      Disallows closing a tab by user
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.disallow_tab_closing">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_editor" class="summary-sig-name">get_editor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item_class</span>)</span><br />
      Return the current editor class for the given model item class
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_editor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_editors" class="summary-sig-name">get_editors</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item_class</span>)</span><br />
      Return all registered editors for the given model item class.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_editors">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_keyword" class="summary-sig-name">get_keyword</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Returns the keyword object with the given name or None
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_keyword">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_keyword_details" class="summary-sig-name">get_keyword_details</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Returns details (documentation, source) of keyword with name <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">name</tt>.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_keyword_details">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_plugins" class="summary-sig-name">get_plugins</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns list containing plugin wrapper for every loaded plugin.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_plugins">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code class="link">InitFile</code>, <code class="link">TestCaseFile</code> or <code class="link">ResourceFile</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_selected_datafile" class="summary-sig-name">get_selected_datafile</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the data file that is currently selected in the tree.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_selected_datafile">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code class="link">InitFile</code>, <code class="link">TestCaseFile</code>, <code class="link">ResourceFile</code>, <code class="link">TestCase</code> or <code class="link">UserKeyword</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_selected_item" class="summary-sig-name">get_selected_item</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the item that is currently selected in the tree.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_selected_item">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#get_user_keyword" class="summary-sig-name">get_user_keyword</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Returns user keyword instance whose name is <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">name</tt> or None.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.get_user_keyword">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#is_library_keyword" class="summary-sig-name">is_library_keyword</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Returns whether <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">name</tt> is a keyword imported by current datafile.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.is_library_keyword">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#is_unsaved_changes" class="summary-sig-name">is_unsaved_changes</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns True if there is any unsaved changes, otherwise False
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.is_unsaved_changes">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#is_user_keyword" class="summary-sig-name">is_user_keyword</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Returns whether <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">name</tt> is a user keyword of current datafile.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.is_user_keyword">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#new_suite_can_be_opened" class="summary-sig-name">new_suite_can_be_opened</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks are there modified files and asks user what to do if there are.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.new_suite_can_be_opened">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#open_suite" class="summary-sig-name">open_suite</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path</span>)</span><br />
      Opens a test suite specified by the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">path</tt>.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.open_suite">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#publish" class="summary-sig-name">publish</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">topic</span>,
        <span class="summary-sig-arg">data</span>)</span><br />
      Publishes a message with given topic and client data.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.publish">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#register_action" class="summary-sig-name">register_action</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">action_info</span>)</span><br />
      Registers a menu entry and optionally a shortcut and a toolbar icon.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.register_action">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#register_actions" class="summary-sig-name">register_actions</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">action_infos</span>)</span><br />
      Registers multiple menu entries and shortcuts/icons.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.register_actions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#register_content_assist_hook" class="summary-sig-name">register_content_assist_hook</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">hook</span>)</span><br />
      Allows plugin to insert values in content assist dialog.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.register_content_assist_hook">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#register_editor" class="summary-sig-name">register_editor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item_class</span>,
        <span class="summary-sig-arg">editor_class</span>,
        <span class="summary-sig-arg">activate</span>=<span class="summary-sig-default">True</span>)</span><br />
      Register <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">editor_class</tt> as an editor class for model items of type <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">item_class</tt>
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.register_editor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#save_all_unsaved_changes" class="summary-sig-name">save_all_unsaved_changes</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Saves all the data files that are modified.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.save_all_unsaved_changes">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#save_selected_datafile" class="summary-sig-name">save_selected_datafile</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Saves the data file that is currently selected in the tree.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.save_selected_datafile">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#save_setting" class="summary-sig-name">save_setting</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">override</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">delay</span>=<span class="summary-sig-default">0</span>)</span><br />
      Saves the specified setting into the RIDE configuration file.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.save_setting">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#select_user_keyword_node" class="summary-sig-name">select_user_keyword_node</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">uk</span>)</span><br />
      Selects node containing the given <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">uk</tt> in the tree.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.select_user_keyword_node">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#set_active_editor" class="summary-sig-name">set_active_editor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item_class</span>,
        <span class="summary-sig-arg">editor_class</span>)</span><br />
      Activates the specified editor to be used with the specified model item.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.set_active_editor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#show_tab" class="summary-sig-name">show_tab</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tab</span>)</span><br />
      Makes the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">tab</tt> added using <a href="robotide.pluginapi.plugin.Plugin-class.html#add_tab" class="link">add_tab</a> visible.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.show_tab">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#subscribe" class="summary-sig-name">subscribe</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">listener</span>,
        <span class="summary-sig-arg">*topics</span>)</span><br />
      Start to listen to messages with the given <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">topics</tt>.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.subscribe">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#tab_is_visible" class="summary-sig-name">tab_is_visible</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tab</span>)</span><br />
      Returns is the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">tab</tt> added using <a href="robotide.pluginapi.plugin.Plugin-class.html#add_tab" class="link">add_tab</a> visible or not.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.tab_is_visible">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#unregister_actions" class="summary-sig-name">unregister_actions</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Unregisters all actions registered by this plugin.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.unregister_actions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#unregister_editor" class="summary-sig-name">unregister_editor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item_class</span>,
        <span class="summary-sig-arg">editor_class</span>)</span><br />
      Unregisters <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">editor_class</tt> as an editor class for model items of type <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">item_class</tt>
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.unregister_editor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#unsubscribe" class="summary-sig-name">unsubscribe</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">listener</span>,
        <span class="summary-sig-arg">*topics</span>)</span><br />
      Stops listening to messages with the given <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">topics</tt>.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.unsubscribe">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.pluginapi.plugin.Plugin-class.html#unsubscribe_all" class="summary-sig-name">unsubscribe_all</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Stops to listen to all messages this plugin has subscribed to.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.pluginapi.plugin-pysrc.html#Plugin.unsubscribe_all">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#doc" class="summary-name">doc</a><br />
      Plugin documentation. Set in <a href="robotide.pluginapi.plugin.Plugin-class.html#__init__" class="link">__init__</a> based on the given doc or
the class docstring.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#initially_enabled" class="summary-name">initially_enabled</a><br />
      Specifies should the plugin be enabled when first loaded.
Set in <a href="robotide.pluginapi.plugin.Plugin-class.html#__init__" class="link">__init__</a>.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#metadata" class="summary-name">metadata</a><br />
      Plugin metadata. Set in <a href="robotide.pluginapi.plugin.Plugin-class.html#__init__" class="link">__init__</a> based on the given metadata.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#name" class="summary-name">name</a><br />
      Plugin name. Set in <a href="robotide.pluginapi.plugin.Plugin-class.html#__init__" class="link">__init__</a> based on the given name or the class name.
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#datafile" class="summary-name">datafile</a><br />
      Currently selected datafile
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#frame" class="summary-name">frame</a><br />
      Reference to the RIDE main frame
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#menubar" class="summary-name">menubar</a><br />
      Provides access to the application menubar
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#model" class="summary-name">model</a><br />
      Provides access to the data model
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#notebook" class="summary-name">notebook</a><br />
      Provides access to the tabbed notebook
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#toolbar" class="summary-name">toolbar</a><br />
      Provides access to the application toolbar
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.pluginapi.plugin.Plugin-class.html#tree" class="summary-name">tree</a><br />
      Provides access to the suite and resource tree
      <em>(Inherited from <a href="robotide.pluginapi.plugin.Plugin-class.html">robotide.pluginapi.plugin.Plugin</a>)</em>
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">application</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initialize the plugin with the provided data.</p>
<p>The provided information is mainly used by the plugin manager. Simple
plugins are often fine with the defaults. If this method is overridden,
the plugin must call it explicitly:</p>
<pre class="rst-rst-rst-rst-literal-block rst-rst-rst-literal-block rst-rst-literal-block rst-literal-block">
from robotide.pluginapi import Plugin

class MyCoolPluginExample(Plugin):
    &quot;&quot;&quot;This extra cool docstring is used as the plugin doc.&quot;&quot;&quot;
    def __init__(self, application):
        Plugin.__init__(self, application, metadata={'version': '0.1'},
                        default_settings={'color': 'red', 'x': 42})
</pre>
<p>Plugins should not create any user interface elements at this point but
wait until the <a href="robotide.editor.EditorPlugin-class.html#enable" class="link">enable</a> method is called.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>application</code></strong> - RIDE application reference.</li>
        <li><strong class="pname"><code>name</code></strong> - Name of the plugin. If not specified, the name is got from the
plugin class name dropping possible <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">Plugin</tt> from the end.</li>
        <li><strong class="pname"><code>doc</code></strong> - Plugin documentation. If not specified, the doc is got from the
plugin class docstring.</li>
        <li><strong class="pname"><code>metadata</code></strong> - A dictionary of free metadata shown on the plugin manager. Values
containing URLs will be shown as links.</li>
        <li><strong class="pname"><code>default_settings</code></strong> - A dictionary of settings and their default values. Settings are
automatically stored onto RIDE configuration file, can be
accessed using direct attribute access via <a href="robotide.pluginapi.plugin.Plugin-class.html#__getattr__" class="link">__getattr__</a>, and new
settings can be saved using <a href="robotide.pluginapi.plugin.Plugin-class.html#save_setting" class="link">save_setting</a>.</li>
        <li><strong class="pname"><code>initially_enabled</code></strong> - Specifies should the plugin be enabled when loaded for the first
time. Users can change the status later from the plugin manager.</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="enable"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">enable</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.enable">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This method is called by RIDE when the plugin is enabled.</p>
<p>Possible integration to UI should be done in this method and removed
when the <a href="robotide.editor.EditorPlugin-class.html#disable" class="link">disable</a> method is called.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="robotide.pluginapi.plugin.Plugin-class.html#enable">pluginapi.plugin.Plugin.enable</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="disable"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">disable</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.disable">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called by RIDE when the plugin is disabled.</p>
<p>Undo whatever was done in the <a href="robotide.editor.EditorPlugin-class.html#enable" class="link">enable</a> method.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="robotide.pluginapi.plugin.Plugin-class.html#disable">pluginapi.plugin.Plugin.disable</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="highlight_cell"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">highlight_cell</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">obj</span>,
        <span class="sig-arg">row</span>,
        <span class="sig-arg">column</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.highlight_cell">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  Highlight a specific row/column of a test case or user keyword
  <dl class="fields">
    <dt>Overrides:
        <a href="robotide.pluginapi.plugin.Plugin-class.html#highlight_cell">pluginapi.plugin.Plugin.highlight_cell</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="highlight"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">highlight</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">text</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.highlight">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  Highlight a specific text of a given data's editor
  <dl class="fields">
    <dt>Overrides:
        <a href="robotide.pluginapi.plugin.Plugin-class.html#highlight">pluginapi.plugin.Plugin.highlight</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="register_context_menu_hook_to_grid"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">register_context_menu_hook_to_grid</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">hook</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.register_context_menu_hook_to_grid">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Used to register own items to grid's right click context menu</p>
<p>hook is called with current selection (list of list containing
values) and it is expected to return list of PopupMenuItem.
If user selects one of the returned PopupMenuItem, related function
is called with one argument, the wx event.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="unregister_context_menu_hook_to_grid"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">unregister_context_menu_hook_to_grid</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">hook</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.unregister_context_menu_hook_to_grid">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="OnTreeItemSelected"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OnTreeItemSelected</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">message</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnTreeItemSelected">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="OnOpenEditor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OnOpenEditor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">event</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnOpenEditor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="OnTabChanged"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OnTabChanged</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">event</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnTabChanged">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="OnTabChanging"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OnTabChanging</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnTabChanging">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="OnSaveToModel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OnSaveToModel</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.editor-pysrc.html#EditorPlugin.OnSaveToModel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Apr 13 15:09:39 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
